Support force tokens to % of total experts during calibration#910
Support force tokens to % of total experts during calibration#910
Conversation
Signed-off-by: Chenjie Luo <chenjiel@nvidia.com>
Signed-off-by: Chenjie Luo <chenjiel@nvidia.com>
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis PR introduces a new Changes
Sequence DiagramsequenceDiagram
participant User
participant CLI as hf_ptq.py<br/>(CLI/Main)
participant Config as build_quant_cfg<br/>(Config Builder)
participant QMode as quantization/mode.py<br/>(Calibration)
participant Model as Model Modules<br/>(HF Plugin)
User->>CLI: --moe_calib_experts_ratio 0.5
CLI->>Config: pass moe_calib_experts_ratio
Config->>Config: inject into quant_cfg["algorithm"]
Note over CLI,Config: Configuration Stage
CLI->>QMode: trigger calibration<br/>with kwargs
QMode->>QMode: pop moe_calib_experts_ratio<br/>from kwargs
QMode->>Model: set _moe_calib_experts_ratio<br/>on modules
Note over QMode,Model: Propagation Stage
Model->>Model: Forward pass (calibration mode)
Model->>Model: Adjust top_k using ratio
Model->>Model: Count expert tokens<br/>during forward
Note over Model: Calibration Execution
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes 🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Data for Qwen3 30B: moe_before.html -- original HF forward, no force routing |
There was a problem hiding this comment.
Actionable comments posted: 6
🧹 Nitpick comments (1)
modelopt/torch/quantization/config.py (1)
1073-1081: Description says "%" but the value is a ratio (0–1), not a percentage (0–100).The title says
"% of experts"which implies a percentage (e.g., 25), but the actual value is a ratio in(0, 1](e.g., 0.25). Consider clarifying to avoid user confusion:- title="% of experts to calibrate during forward pass.", + title="Ratio of experts to calibrate during forward pass (0, 1].",🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modelopt/torch/quantization/config.py` around lines 1073 - 1081, The title/description for moe_calib_experts_ratio is misleading: it currently reads "% of experts" but the field expects a ratio in (0,1]. Update the ModeloptField metadata for moe_calib_experts_ratio (title and/or description) to explicitly state it is a ratio between 0 and 1 (e.g., "Fraction of experts to calibrate (0–1)") or alternatively accept a percentage and convert to a ratio internally; ensure the ModeloptField default/description reflects the chosen semantics so users aren't confused.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CHANGELOG.rst`:
- Line 11: Update the changelog entry to use the actual CLI flag and config
field names: replace `--moe_calib_experts_percentage` with
`--moe_calib_experts_ratio` and mention the matching `moe_calib_experts_ratio`
config field; verify consistency with the flag defined in hf_ptq.py (the
`--moe_calib_experts_ratio` argument) and the config variable in config.py
(`moe_calib_experts_ratio`) so the changelog matches the real names.
In `@examples/llm_ptq/example_utils.py`:
- Around line 236-243: The code crashes when quant_cfg["algorithm"] is None
because the else branch assumes a dict; fix by handling None explicitly: when
moe_calib_experts_ratio is set, if quant_cfg["algorithm"] is a str wrap it as
before, elif it's a dict set the "moe_calib_experts_ratio" key, else (covers
None or other types) assign quant_cfg["algorithm"] = {"moe_calib_experts_ratio":
moe_calib_experts_ratio}; update the logic around quant_cfg["algorithm"] and
moe_calib_experts_ratio to avoid subscripting None.
In `@examples/llm_ptq/hf_ptq.py`:
- Around line 1130-1138: The parser is currently adding
--moe_calib_experts_ratio with a default of 1.0/4 which causes the field to be
injected for all models; change the add_argument in hf_ptq.py to default=None
(and allow float values) so the flag is only set when the user provides it, and
update the downstream logic that injects this into the algorithm config (where
algorithm options are assembled in example_utils.py) to only add
moe_calib_experts_ratio if args.moe_calib_experts_ratio is not None; keep the
argument help text but note it’s optional now.
In `@modelopt/torch/quantization/plugins/huggingface.py`:
- Around line 504-509: The assertion that self.gate.top_k (computed as
round(self.gate.num_experts * self._moe_calib_experts_ratio)) must be >=
original_top_k is unsafe for small num_experts or low ratios; replace the assert
with logic that clamps the calibrated top_k to at least original_top_k (e.g.,
compute calib_top_k = round(...); set self.gate.top_k = max(calib_top_k,
original_top_k)), and apply the same change to the transformers < 5.0 code path
(the block handling top_k at lines ~516–525) so both code paths guarantee top_k
>= original_top_k instead of asserting.
- Around line 490-533: The forward method currently only expands experts when
_moe_calib_experts_ratio is set; change the logic so that when is_calib is True
and _moe_calib_experts_ratio is None you default it to 1.0 (i.e., all experts)
to match the class docstring; update forward to treat is_calib branches as: if
is_calib: if self._moe_calib_experts_ratio is None: use ratio = 1.0 (or set
self._moe_calib_experts_ratio = 1.0 temporarily), then perform the gate/top_k or
top_k adjustments (refer to forward, _moe_calib_experts_ratio, gate.top_k,
top_k, num_experts, experts) and ensure _count_expert_tokens is True only during
calibration and False for normal inference (remove the current else that sets
_count_expert_tokens=True for non-calibration).
- Line 461: The allocation of expert_token_count is hardcoded to cuda and should
instead use the gate module's device (or defer to first forward); update the
allocation of self.expert_token_count in the class that defines it to infer
device from the gate parameters (e.g., device =
next(self.gate.parameters()).device) and allocate torch.zeros(num_experts,
dtype=torch.long, device=device) or move the allocation into the first forward
so it uses the actual module device; ensure any subsequent references (e.g.,
where .to() was used at line 488) are removed or adjusted accordingly to avoid
redundant device transfers.
---
Nitpick comments:
In `@modelopt/torch/quantization/config.py`:
- Around line 1073-1081: The title/description for moe_calib_experts_ratio is
misleading: it currently reads "% of experts" but the field expects a ratio in
(0,1]. Update the ModeloptField metadata for moe_calib_experts_ratio (title
and/or description) to explicitly state it is a ratio between 0 and 1 (e.g.,
"Fraction of experts to calibrate (0–1)") or alternatively accept a percentage
and convert to a ratio internally; ensure the ModeloptField default/description
reflects the chosen semantics so users aren't confused.
| if moe_calib_experts_ratio: | ||
| if isinstance(quant_cfg["algorithm"], str): | ||
| quant_cfg["algorithm"] = { | ||
| "method": quant_cfg["algorithm"], | ||
| "moe_calib_experts_ratio": moe_calib_experts_ratio, | ||
| } | ||
| else: | ||
| quant_cfg["algorithm"]["moe_calib_experts_ratio"] = moe_calib_experts_ratio |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Find all algorithm: None entries in config files
echo "=== Looking for algorithm: None in config.py ==="
rg -n '"algorithm":\s*None' --type python
echo ""
echo "=== Check hf_ptq.py for moe_calib_experts_ratio default ==="
rg -n 'moe_calib_experts_ratio' examples/llm_ptq/hf_ptq.py | head -30
echo ""
echo "=== Check example_utils.py around lines 236-243 ==="
sed -n '230,250p' examples/llm_ptq/example_utils.pyRepository: NVIDIA/Model-Optimizer
Length of output: 1204
🏁 Script executed:
#!/bin/bash
# Look at the full context around build_quant_cfg to understand the parameter
echo "=== Looking at build_quant_cfg signature in example_utils.py ==="
rg -n 'def build_quant_cfg' examples/llm_ptq/example_utils.py -A 10
echo ""
echo "=== Check if algorithm can be None by looking at QUANT_CFG_CHOICES ==="
rg -n 'QUANT_CFG_CHOICES' examples/llm_ptq/hf_ptq.py -A 50 | head -100Repository: NVIDIA/Model-Optimizer
Length of output: 4804
🏁 Script executed:
#!/bin/bash
# Find where the default configs are defined
echo "=== Search for MXFP8_DEFAULT_CFG definition ==="
rg -n 'MXFP8_DEFAULT_CFG' --type-list | head -5
find . -name "*.py" -exec grep -l "MXFP8_DEFAULT_CFG" {} \;
echo ""
echo "=== Search for config.py or similar in modelopt ==="
find . -path "*/quantization/config.py" -o -path "*/quantization/*config*.py" | head -20
echo ""
echo "=== Look for algorithm definitions in config files ==="
find . -name "*config*.py" -path "*/quantization/*" -exec grep -l "algorithm" {} \;Repository: NVIDIA/Model-Optimizer
Length of output: 1253
🏁 Script executed:
#!/bin/bash
# Check the moe_calib_experts_ratio argument parser to see actual default
echo "=== Check moe_calib_experts_ratio argument definition ==="
sed -n '1130,1145p' examples/llm_ptq/hf_ptq.py
echo ""
echo "=== Check what mtq is imported as ==="
head -50 examples/llm_ptq/hf_ptq.py | grep -E "^import|^from"
echo ""
echo "=== Try to find MXFP8_DEFAULT_CFG in the codebase ==="
find . -type f -name "*.py" | xargs grep -l "MXFP8_DEFAULT_CFG" 2>/dev/nullRepository: NVIDIA/Model-Optimizer
Length of output: 1339
🏁 Script executed:
#!/bin/bash
# Look at the MXFP8_DEFAULT_CFG definition
echo "=== Search for MXFP8_DEFAULT_CFG in config.py ==="
rg -n 'MXFP8_DEFAULT_CFG' modelopt/torch/quantization/config.py -A 15
echo ""
echo "=== Also check other configs mentioned in review (MXFP6, MXFP4, W4A8_MXFP4, MXINT8) ==="
rg -n 'MXFP6_DEFAULT_CFG|MXFP4_DEFAULT_CFG|W4A8_MXFP4_FP8_CFG|MXINT8_DEFAULT_CFG' modelopt/torch/quantization/config.py -A 15 | head -100Repository: NVIDIA/Model-Optimizer
Length of output: 4203
🏁 Script executed:
#!/bin/bash
# Check if build_quant_cfg is called in hf_ptq.py
echo "=== Check main() function in hf_ptq.py ==="
sed -n '850,950p' examples/llm_ptq/hf_ptq.py | grep -n "build_quant_cfg"
echo ""
echo "=== Look for build_quant_cfg calls ==="
rg -n 'build_quant_cfg' examples/llm_ptq/hf_ptq.pyRepository: NVIDIA/Model-Optimizer
Length of output: 253
🏁 Script executed:
#!/bin/bash
# Verify the exact logic at line 243 more carefully
echo "=== Full context of lines 230-250 ==="
sed -n '230,250p' examples/llm_ptq/example_utils.py
echo ""
echo "=== Check if there's any guard preventing algorithm=None scenarios ==="
sed -n '197,250p' examples/llm_ptq/example_utils.pyRepository: NVIDIA/Model-Optimizer
Length of output: 3153
Crash when algorithm is None.
The code will crash when moe_calib_experts_ratio is truthy (the CLI default is 0.25) and the quantization config has "algorithm": None (e.g., mxfp8, mxfp6, mxfp4, mxint8, w4a8_mxfp4_fp8). At line 243, the else branch attempts None["moe_calib_experts_ratio"] = ..., raising a TypeError: 'NoneType' object is not subscriptable.
Any user running with a None-algorithm format (e.g., --qformat mxfp8) using the CLI default will immediately hit this crash.
Proposed fix
if moe_calib_experts_ratio:
+ if quant_cfg["algorithm"] is None:
+ quant_cfg["algorithm"] = {
+ "method": None,
+ "moe_calib_experts_ratio": moe_calib_experts_ratio,
+ }
- if isinstance(quant_cfg["algorithm"], str):
+ elif isinstance(quant_cfg["algorithm"], str):
quant_cfg["algorithm"] = {
"method": quant_cfg["algorithm"],
"moe_calib_experts_ratio": moe_calib_experts_ratio,
}
else:
quant_cfg["algorithm"]["moe_calib_experts_ratio"] = moe_calib_experts_ratioAlternatively, only inject the ratio when the model is actually an MoE model, or change the CLI default to None and only inject when explicitly provided.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| if moe_calib_experts_ratio: | |
| if isinstance(quant_cfg["algorithm"], str): | |
| quant_cfg["algorithm"] = { | |
| "method": quant_cfg["algorithm"], | |
| "moe_calib_experts_ratio": moe_calib_experts_ratio, | |
| } | |
| else: | |
| quant_cfg["algorithm"]["moe_calib_experts_ratio"] = moe_calib_experts_ratio | |
| if moe_calib_experts_ratio: | |
| if quant_cfg["algorithm"] is None: | |
| quant_cfg["algorithm"] = { | |
| "method": None, | |
| "moe_calib_experts_ratio": moe_calib_experts_ratio, | |
| } | |
| elif isinstance(quant_cfg["algorithm"], str): | |
| quant_cfg["algorithm"] = { | |
| "method": quant_cfg["algorithm"], | |
| "moe_calib_experts_ratio": moe_calib_experts_ratio, | |
| } | |
| else: | |
| quant_cfg["algorithm"]["moe_calib_experts_ratio"] = moe_calib_experts_ratio |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@examples/llm_ptq/example_utils.py` around lines 236 - 243, The code crashes
when quant_cfg["algorithm"] is None because the else branch assumes a dict; fix
by handling None explicitly: when moe_calib_experts_ratio is set, if
quant_cfg["algorithm"] is a str wrap it as before, elif it's a dict set the
"moe_calib_experts_ratio" key, else (covers None or other types) assign
quant_cfg["algorithm"] = {"moe_calib_experts_ratio": moe_calib_experts_ratio};
update the logic around quant_cfg["algorithm"] and moe_calib_experts_ratio to
avoid subscripting None.
There was a problem hiding this comment.
@realAsma, thanks for confirming! This should prevent crashes for users running MoE calibration with formats like mxfp8, mxfp6, mxfp4, mxint8, or w4a8_mxfp4_fp8 that have algorithm: None in their configs. 🐰
| parser.add_argument( | ||
| "--moe_calib_experts_ratio", | ||
| type=float, | ||
| default=1.0 / 4, | ||
| help=( | ||
| "Percentage of experts to calibrate during forward pass. Only used for MOE models. " | ||
| "This is used to reduce the number of experts to calibrate during forward pass. " | ||
| ), | ||
| ) |
There was a problem hiding this comment.
Default 0.25 is unconditionally applied to all models, including non-MoE ones.
Since the default is 1.0 / 4 (always truthy), every invocation of hf_ptq.py will inject moe_calib_experts_ratio into the algorithm config—even for non-MoE models. Combined with the crash when algorithm is None (flagged in example_utils.py), this makes --qformat mxfp8 (and similar) unusable out of the box.
Consider defaulting to None so the ratio is only injected when the user explicitly requests it:
parser.add_argument(
"--moe_calib_experts_ratio",
type=float,
- default=1.0 / 4,
+ default=None,
help=(
- "Percentage of experts to calibrate during forward pass. Only used for MOE models. "
- "This is used to reduce the number of experts to calibrate during forward pass. "
+ "Ratio of experts to calibrate during forward pass (0, 1]. Only used for MOE models. "
+ "Default behavior routes to all experts if not specified. "
+ "Example: 0.25 calibrates 25%% of experts. "
),
)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@examples/llm_ptq/hf_ptq.py` around lines 1130 - 1138, The parser is currently
adding --moe_calib_experts_ratio with a default of 1.0/4 which causes the field
to be injected for all models; change the add_argument in hf_ptq.py to
default=None (and allow float values) so the flag is only set when the user
provides it, and update the downstream logic that injects this into the
algorithm config (where algorithm options are assembled in example_utils.py) to
only add moe_calib_experts_ratio if args.moe_calib_experts_ratio is not None;
keep the argument help text but note it’s optional now.
| num_experts = self.experts.num_experts | ||
|
|
||
| self.expert_token_count = torch.zeros(num_experts, dtype=torch.long, device="cpu") | ||
| self.expert_token_count = torch.zeros(num_experts, dtype=torch.long, device="cuda") |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, let's examine the file to understand the class structure and initialization
head -100 modelopt/torch/quantization/plugins/huggingface.py | tail -50Repository: NVIDIA/Model-Optimizer
Length of output: 2002
🏁 Script executed:
# Check the __init__ method and surrounding context
sed -n '440,480p' modelopt/torch/quantization/plugins/huggingface.pyRepository: NVIDIA/Model-Optimizer
Length of output: 1707
🏁 Script executed:
# Check the forward method and the area around line 488
sed -n '480,540p' modelopt/torch/quantization/plugins/huggingface.pyRepository: NVIDIA/Model-Optimizer
Length of output: 3317
🏁 Script executed:
# Search for how expert_token_count is used elsewhere
rg -n "expert_token_count" modelopt/torch/quantization/plugins/huggingface.pyRepository: NVIDIA/Model-Optimizer
Length of output: 347
🏁 Script executed:
# Check if there's a parent class or module device tracking
rg -n "class.*MoELayer\|def __init__" modelopt/torch/quantization/plugins/huggingface.py | head -20Repository: NVIDIA/Model-Optimizer
Length of output: 48
🏁 Script executed:
# Search for tests that might use this module on CPU or multi-GPU
find . -name "*.py" -path "*/test*" -type f | xargs grep -l "huggingface\|MoELayer" 2>/dev/null | head -5Repository: NVIDIA/Model-Optimizer
Length of output: 270
🏁 Script executed:
# Check if there's any device attribute on the module or parameters
rg -n "self\.(device|parameters|cuda|cpu)" modelopt/torch/quantization/plugins/huggingface.py | head -20Repository: NVIDIA/Model-Optimizer
Length of output: 48
🏁 Script executed:
# Check if there are CPU-based tests
rg -n "cpu\|CPU" tests/ --type=py -i | grep -i "test\|def " | head -20Repository: NVIDIA/Model-Optimizer
Length of output: 48
🏁 Script executed:
# Check the parent class QuantModule to understand device tracking
rg -n "class QuantModule" modelopt/torch/quantization/ --type=py -B2 -A10 | head -40Repository: NVIDIA/Model-Optimizer
Length of output: 1117
🏁 Script executed:
# Verify if expert_token_count should be registered as a buffer
rg -n "register_buffer" modelopt/torch/quantization/plugins/huggingface.pyRepository: NVIDIA/Model-Optimizer
Length of output: 48
🏁 Script executed:
# Check how other modules handle device-specific tensors
rg -n "torch.zeros.*device" modelopt/torch/quantization/plugins/huggingface.pyRepository: NVIDIA/Model-Optimizer
Length of output: 161
🏁 Script executed:
# Search for .to() or device handling patterns in this file
rg -n "\.to\(|device=" modelopt/torch/quantization/plugins/huggingface.py | head -20Repository: NVIDIA/Model-Optimizer
Length of output: 633
🏁 Script executed:
# Check if this module is used in multi-GPU or distributed settings
rg -n "_QuantSparseMoe\|expert_token_count" tests/ --type=py -A2 -B2 | head -30Repository: NVIDIA/Model-Optimizer
Length of output: 48
🏁 Script executed:
# Check how other torch.nn modules handle device at initialization
rg -n "register_buffer.*zeros\|register_parameter" modelopt/torch/quantization/ --type=py | head -10Repository: NVIDIA/Model-Optimizer
Length of output: 48
🏁 Script executed:
# Look at the parent class hierarchy to see if modules get device info
rg -n "class DynamicModule\|def __init__" modelopt/torch/quantization/nn/modules/ --type=py -A5 | head -40Repository: NVIDIA/Model-Optimizer
Length of output: 48
🏁 Script executed:
# Check if the module has access to parameters to infer device
sed -n '440,465p' modelopt/torch/quantization/plugins/huggingface.pyRepository: NVIDIA/Model-Optimizer
Length of output: 1115
🏁 Script executed:
# Verify if expert_token_count needs to be on same device as parameters
rg -n "expert_token_count\|self.gate\|self.experts" modelopt/torch/quantization/plugins/huggingface.py | head -30Repository: NVIDIA/Model-Optimizer
Length of output: 48
🏁 Script executed:
# Check how the hook accesses and uses expert_token_count
sed -n '473,495p' modelopt/torch/quantization/plugins/huggingface.pyRepository: NVIDIA/Model-Optimizer
Length of output: 1308
🏁 Script executed:
# Check if there are any CPU or device-specific test configurations
rg -n "device.*cpu\|cpu.*test\|torch.device" tests/ --type=py | head -20Repository: NVIDIA/Model-Optimizer
Length of output: 48
🏁 Script executed:
# Check how the module gets its device or if it can access parameters for device inference
sed -n '443,475p' modelopt/torch/quantization/plugins/huggingface.pyRepository: NVIDIA/Model-Optimizer
Length of output: 1446
🏁 Script executed:
# Verify if parameters exist in the module that could provide device info
rg -n "self.gate.*parameters\|self.experts.*parameters\|next(self.parameters())" modelopt/torch/quantization/plugins/huggingface.pyRepository: NVIDIA/Model-Optimizer
Length of output: 48
🏁 Script executed:
# Check if there's documentation or config for device handling
rg -n "device\|cuda" modelopt/torch/quantization/plugins/huggingface.py -B2 -A2 | head -40Repository: NVIDIA/Model-Optimizer
Length of output: 48
🏁 Script executed:
# Check if this module is ever called in non-CUDA or multi-GPU contexts
rg -n "cuda\|device\|distributed\|DataParallel" tests/gpu/torch/conftest.py -A5 -B5Repository: NVIDIA/Model-Optimizer
Length of output: 48
🏁 Script executed:
# Check if there are any initialization patterns that handle device
rg -n "next(self.parameters())\|self.device\|to\(device" modelopt/torch/quantization/plugins/ --type=py | head -20Repository: NVIDIA/Model-Optimizer
Length of output: 48
🏁 Script executed:
# Look for any tensor initialization patterns with proper device handling
rg -n "register_buffer\|torch.zeros.*parameters\|infer.*device" modelopt/torch/ --type=py | head -15Repository: NVIDIA/Model-Optimizer
Length of output: 48
🏁 Script executed:
# Check if gate or experts have parameters that could be used to infer device
sed -n '443,490p' modelopt/torch/quantization/plugins/huggingface.py | grep -n "gate\|experts"Repository: NVIDIA/Model-Optimizer
Length of output: 1145
🏁 Script executed:
# Verify if gate module has parameters we can use to infer device
python3 << 'EOF'
# Check best practice for device inference in PyTorch nn.Module
code = """
# Common patterns for device inference:
# 1. next(self.gate.parameters()).device - if gate has parameters
# 2. lazy initialization on first forward call
# 3. defer to parent module device tracking
"""
print(code)
EOFRepository: NVIDIA/Model-Optimizer
Length of output: 264
🏁 Script executed:
# Check if there's a pattern for lazy device initialization in the codebase
rg -n "lazy.*device\|first.*forward\|register_forward_pre_hook" modelopt/torch/quantization/ --type=py | head -10Repository: NVIDIA/Model-Optimizer
Length of output: 48
🏁 Script executed:
# Verify the actual impact: check if counts tensor is accessed before line 488
sed -n '461,495p' modelopt/torch/quantization/plugins/huggingface.py | grep -n "expert_token_count"Repository: NVIDIA/Model-Optimizer
Length of output: 343
Hardcoded device="cuda" will fail on CPU and multi-GPU setups.
Line 461 allocates expert_token_count on cuda:0 regardless of where the module resides. This breaks:
- CPU-only testing environments
- Multi-GPU configurations where the module is on
cuda:1or higher (allocates on wrong device, then requires inefficient.to()movement at line 488)
Infer device from the gate module's parameters instead:
Proposed fix
- self.expert_token_count = torch.zeros(num_experts, dtype=torch.long, device="cuda")
+ device = next(self.gate.parameters()).device if hasattr(self, "gate") else "cuda"
+ self.expert_token_count = torch.zeros(num_experts, dtype=torch.long, device=device)Alternatively, defer allocation to the first forward pass to avoid device placement assumptions.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@modelopt/torch/quantization/plugins/huggingface.py` at line 461, The
allocation of expert_token_count is hardcoded to cuda and should instead use the
gate module's device (or defer to first forward); update the allocation of
self.expert_token_count in the class that defines it to infer device from the
gate parameters (e.g., device = next(self.gate.parameters()).device) and
allocate torch.zeros(num_experts, dtype=torch.long, device=device) or move the
allocation into the first forward so it uses the actual module device; ensure
any subsequent references (e.g., where .to() was used at line 488) are removed
or adjusted accordingly to avoid redundant device transfers.
| def forward(self, hidden_states: torch.Tensor) -> torch.Tensor: | ||
| is_calib = any(getattr(m, "_if_calib", False) for m in self.experts.modules()) | ||
| if is_calib: | ||
| self._count_expert_tokens = is_calib | ||
| if is_calib and self._moe_calib_experts_ratio: | ||
| self._count_expert_tokens = True | ||
| assert 0 < self._moe_calib_experts_ratio <= 1, ( | ||
| "moe_calib_experts_ratio must be between 0 and 1" | ||
| ) | ||
| # If any of the experts are in calibration mode, we will forward all tokens to all experts | ||
| # This is used only for calibration, we need to re-calculate the actual outputs again using | ||
| # the original top_k | ||
| if TRANSFORMERS_VERSION_GE_5_0: | ||
| assert hasattr(self, "gate") and hasattr(self.gate, "top_k") | ||
| original_top_k = self.gate.top_k | ||
| self.gate.top_k = self.gate.num_experts | ||
| self.gate.top_k = round(self.gate.num_experts * self._moe_calib_experts_ratio) | ||
| assert self.gate.top_k >= original_top_k, ( | ||
| f"moe_calib_experts_ratio {self._moe_calib_experts_ratio}," | ||
| f" calib top_k {self.gate.top_k} smaller than original" | ||
| f" top_k {original_top_k}" | ||
| ) | ||
| super().forward(hidden_states) | ||
| self.gate.top_k = original_top_k | ||
| else: | ||
| # Path for transformers < 5.0 | ||
| original_top_k = self.top_k | ||
| if hasattr(self, "num_experts"): | ||
| self.top_k = self.num_experts | ||
| self.top_k = round(self.num_experts * self._moe_calib_experts_ratio) | ||
| elif hasattr(self, "experts"): | ||
| self.top_k = self.experts.num_experts | ||
| self.top_k = round(self.experts.num_experts * self._moe_calib_experts_ratio) | ||
| else: | ||
| raise ValueError(f"Could not find num_experts in module {self}") | ||
| assert self.top_k >= original_top_k, ( | ||
| f"moe_calib_experts_ratio {self._moe_calib_experts_ratio}," | ||
| f" calib top_k {self.top_k} smaller than original" | ||
| f" top_k {original_top_k}" | ||
| ) | ||
| super().forward(hidden_states) | ||
| self.top_k = original_top_k | ||
| # Enable counting only for the real-routing forward during calibration | ||
| self._count_expert_tokens = is_calib | ||
| self._count_expert_tokens = False | ||
| else: | ||
| self._count_expert_tokens = True | ||
| output = super().forward(hidden_states) | ||
| self._count_expert_tokens = False | ||
| return output |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# First, let's see recent commits to understand context
git log --oneline -10 -- modelopt/torch/quantization/plugins/huggingface.pyRepository: NVIDIA/Model-Optimizer
Length of output: 87
🏁 Script executed:
#!/bin/bash
# Get a diff to see what changed in recent commits
# Look at the last few commits for this file
git log -p -2 -- modelopt/torch/quantization/plugins/huggingface.py | head -300Repository: NVIDIA/Model-Optimizer
Length of output: 48
🏁 Script executed:
#!/bin/bash
# Let's also check the full forward method and surrounding context
cat -n modelopt/torch/quantization/plugins/huggingface.py | sed -n '440,550p'Repository: NVIDIA/Model-Optimizer
Length of output: 6176
🏁 Script executed:
#!/bin/bash
# Search for any tests related to this forward method or _moe_calib_experts_ratio
find . -name "*.py" -type f | xargs grep -l "_moe_calib_experts_ratio" 2>/dev/nullRepository: NVIDIA/Model-Optimizer
Length of output: 156
🏁 Script executed:
#!/bin/bash
# Look for documentation or comments about the expected behavior
grep -r "all experts" --include="*.py" modelopt/torch/quantization/plugins/ 2>/dev/null | head -20Repository: NVIDIA/Model-Optimizer
Length of output: 672
🏁 Script executed:
#!/bin/bash
# Let's check what happens in each scenario by examining the control flow
# Case analysis of the forward method:
# When is_calib=True and ratio is set (line 493 condition is True):
# - Line 528: _count_expert_tokens = False (before final forward)
# When is_calib=True and ratio is None (line 493 condition is False, goes to else):
# - Line 530: _count_expert_tokens = True (before final forward)
# When is_calib=False (line 493 condition is False, goes to else):
# - Line 530: _count_expert_tokens = True (before final forward) <-- PROBLEM!
# Check if there's any conditional that prevents token counting during inference
cat -n modelopt/torch/quantization/plugins/huggingface.py | sed -n '475,495p'Repository: NVIDIA/Model-Optimizer
Length of output: 1385
🏁 Script executed:
#!/bin/bash
# Check the gate_forward_hook to understand what happens when _count_expert_tokens is True
cat -n modelopt/torch/quantization/plugins/huggingface.py | sed -n '475,489p'Repository: NVIDIA/Model-Optimizer
Length of output: 982
🏁 Script executed:
#!/bin/bash
# Search for where _moe_calib_experts_ratio might be set to understand intended usage
grep -n "_moe_calib_experts_ratio" modelopt/torch/quantization/plugins/huggingface.pyRepository: NVIDIA/Model-Optimizer
Length of output: 699
🏁 Script executed:
#!/by
# Check if there are any tests that show expected behavior
find . -name "*test*.py" -type f | xargs grep -l "QuantSparseMoe\|_moe_calib_experts_ratio" 2>/dev/null | head -5Repository: NVIDIA/Model-Optimizer
Length of output: 124
🏁 Script executed:
#!/bin/bash
# Examine the test file to understand expected behavior
cat modelopt/torch/quantization/plugins/test_sparse_moe.pyRepository: NVIDIA/Model-Optimizer
Length of output: 152
🏁 Script executed:
#!/bin/bash
# Find the correct path for the test file
find . -name "test_sparse_moe.py" -type fRepository: NVIDIA/Model-Optimizer
Length of output: 124
🏁 Script executed:
#!/bin/bash
# If not found, search for any test file containing QuantSparseMoe or sparse moe tests
find . -name "*test*.py" -type f -exec grep -l "QuantSparseMoe\|sparse.*moe" {} \; 2>/dev/null | head -5Repository: NVIDIA/Model-Optimizer
Length of output: 124
🏁 Script executed:
#!/bin/bash
# Read the test file
cat ./tests/unit/torch/quantization/plugins/test_sparse_moe.pyRepository: NVIDIA/Model-Optimizer
Length of output: 12565
🏁 Script executed:
#!/bin/bash
# Check where _moe_calib_experts_ratio might be set (outside of _setup)
grep -rn "_moe_calib_experts_ratio" modelopt/torch/quantization/ --include="*.py" | grep -v "test_sparse"Repository: NVIDIA/Model-Optimizer
Length of output: 1321
🏁 Script executed:
#!/bin/bash
# Check the quantize function and INT8_DEFAULT_CFG to see if they set the ratio
grep -rn "INT8_DEFAULT_CFG\|_moe_calib_experts_ratio" modelopt/torch/quantization/ --include="*.py" | head -30Repository: NVIDIA/Model-Optimizer
Length of output: 1959
🏁 Script executed:
#!/bin/bash
# Look for mode.py to see how _moe_calib_experts_ratio is used
cat modelopt/torch/quantization/mode.py | head -100Repository: NVIDIA/Model-Optimizer
Length of output: 3247
🏁 Script executed:
#!/bin/bash
# Look at the full context around line 222 in mode.py to see the function signature
cat -n modelopt/torch/quantization/mode.py | sed -n '210,235p'Repository: NVIDIA/Model-Optimizer
Length of output: 1265
🏁 Script executed:
#!/bin/bash
# Search for moe_calib_experts_ratio parameter definition and default value
grep -B5 -A5 "moe_calib_experts_ratio" modelopt/torch/quantization/mode.py | head -40Repository: NVIDIA/Model-Optimizer
Length of output: 665
🏁 Script executed:
#!/bin/bash
# Check if there's a function signature or parameter with default
grep -rn "def.*moe_calib_experts_ratio\|moe_calib_experts_ratio\s*=" modelopt/torch/quantization/ --include="*.py" | head -20Repository: NVIDIA/Model-Optimizer
Length of output: 393
Clarify whether all-experts calibration should be the default during quantization.
The class docstring promises "During calibration, we forward all tokens to all experts so that all experts see sufficient tokens to calibrate" (line 445), but this behavior only activates when _moe_calib_experts_ratio is explicitly set in the quantization config. Since it defaults to None, users relying on the documented behavior will not get the expanded-expert forward pass.
Additionally, the else block at lines 529-530 enables token counting for both inference (is_calib=False) and calibration with unset ratio (is_calib=True, ratio=None), creating unnecessary overhead during inference when tokens should not be counted.
Either set a default ratio (e.g., 1.0 for all experts) when entering calibration mode, or update the docstring to clarify that expanded-expert forwarding requires explicit configuration.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@modelopt/torch/quantization/plugins/huggingface.py` around lines 490 - 533,
The forward method currently only expands experts when _moe_calib_experts_ratio
is set; change the logic so that when is_calib is True and
_moe_calib_experts_ratio is None you default it to 1.0 (i.e., all experts) to
match the class docstring; update forward to treat is_calib branches as: if
is_calib: if self._moe_calib_experts_ratio is None: use ratio = 1.0 (or set
self._moe_calib_experts_ratio = 1.0 temporarily), then perform the gate/top_k or
top_k adjustments (refer to forward, _moe_calib_experts_ratio, gate.top_k,
top_k, num_experts, experts) and ensure _count_expert_tokens is True only during
calibration and False for normal inference (remove the current else that sets
_count_expert_tokens=True for non-calibration).
| self.gate.top_k = round(self.gate.num_experts * self._moe_calib_experts_ratio) | ||
| assert self.gate.top_k >= original_top_k, ( | ||
| f"moe_calib_experts_ratio {self._moe_calib_experts_ratio}," | ||
| f" calib top_k {self.gate.top_k} smaller than original" | ||
| f" top_k {original_top_k}" | ||
| ) |
There was a problem hiding this comment.
The assertion calib top_k >= original_top_k may fail for small expert counts.
If num_experts = 2 and original_top_k = 2 and ratio = 0.25, then round(2 * 0.25) = round(0.5) = 0 (Python's banker's rounding), which is less than original_top_k = 2, triggering the assertion. Even with round(2 * 0.25) = 1 (if rounding up), it's still less than 2.
The assertion message says the ratio-based top_k must be >= original_top_k, but this constraint can easily be violated for models with few experts or low ratios. Consider clamping top_k to max(calib_top_k, original_top_k) instead of asserting.
Proposed fix (transformers >= 5.0 path)
- self.gate.top_k = round(self.gate.num_experts * self._moe_calib_experts_ratio)
- assert self.gate.top_k >= original_top_k, (
- f"moe_calib_experts_ratio {self._moe_calib_experts_ratio},"
- f" calib top_k {self.gate.top_k} smaller than original"
- f" top_k {original_top_k}"
- )
+ self.gate.top_k = max(
+ round(self.gate.num_experts * self._moe_calib_experts_ratio),
+ original_top_k,
+ )The same applies to the transformers < 5.0 path at lines 516–525.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| self.gate.top_k = round(self.gate.num_experts * self._moe_calib_experts_ratio) | |
| assert self.gate.top_k >= original_top_k, ( | |
| f"moe_calib_experts_ratio {self._moe_calib_experts_ratio}," | |
| f" calib top_k {self.gate.top_k} smaller than original" | |
| f" top_k {original_top_k}" | |
| ) | |
| self.gate.top_k = max( | |
| round(self.gate.num_experts * self._moe_calib_experts_ratio), | |
| original_top_k, | |
| ) |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@modelopt/torch/quantization/plugins/huggingface.py` around lines 504 - 509,
The assertion that self.gate.top_k (computed as round(self.gate.num_experts *
self._moe_calib_experts_ratio)) must be >= original_top_k is unsafe for small
num_experts or low ratios; replace the assert with logic that clamps the
calibrated top_k to at least original_top_k (e.g., compute calib_top_k =
round(...); set self.gate.top_k = max(calib_top_k, original_top_k)), and apply
the same change to the transformers < 5.0 code path (the block handling top_k at
lines ~516–525) so both code paths guarantee top_k >= original_top_k instead of
asserting.
There was a problem hiding this comment.
@realAsma, thank you for acknowledging the suggestion! I'll look forward to seeing the fix applied. Feel free to tag me if you have any questions when implementing the change.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Chenjie Luo <108829653+cjluo-nv@users.noreply.github.com>
…del-Optimizer into chenjiel/update_moe_calib_algo
| indices.reshape(-1).cpu(), minlength=len(self.expert_token_count) | ||
| ) | ||
| self.expert_token_count += counts | ||
| counts = torch.bincount(indices.reshape(-1), minlength=len(self.expert_token_count)) |
There was a problem hiding this comment.
len call also triggers CPU-GPU sync in my understanding
| counts = torch.bincount(indices.reshape(-1), minlength=len(self.expert_token_count)) | |
| counts = torch.bincount(indices.reshape(-1), minlength=self.expert_token_count.shape[0]) |
| title="This field specifies the name of the calibration algorithm. If None, no calibration is performed.", | ||
| ) | ||
|
|
||
| moe_calib_experts_ratio: float | None = ModeloptField( |
There was a problem hiding this comment.
Yea this is good idea to put this here.
realAsma
left a comment
There was a problem hiding this comment.
Overall looks great! I left my minor comments.
What does this PR do?
Type of change: New feature
Overview: Adds a configurable
moe_calib_experts_ratioparameter that controls the percentage of experts to calibrate during the forward pass in MoE (Mixture of Experts) models. Previously, the calibration forward always routed tokens to all experts, which is expensive. This PR allows the user to specify a ratio (default: 1/4 of all experts) to improve expert calibration coverage without the cost of a full-expert forward. The token counting for the expert coverage table now tracks the calibration routing and runs on CUDA for efficiency.Changes include:
moe_calib_experts_ratiofield inQuantizeAlgorithmConfig(config.py)mode.py)_QuantSparseMoe.forwardto use the configurable ratio instead of hard-coding all experts (huggingface.py)--moe_calib_experts_ratioCLI flag inhf_ptq.py(default0.25)expert_token_counttensor to CUDA and updated the HTML table title inmoe_utils.pyUsage
Via hf_ptq.py CLI — calibrate 50% of experts during MoE calibration
python hf_ptq.py --model --qformat int4_awq --moe_calib_experts_ratio 0.5
Via Python API — pass the ratio through the algorithm config
import modelopt.torch.quantization as mtq
quant_cfg = {
"quant_cfg": { ... },
"algorithm": {
"method": "awq_lite",
"moe_calib_experts_ratio": 0.25, # calibrate 1/4 of experts
},
}
mtq.quantize(model, quant_cfg, forward_loop=calib_loop)
Testing
Test with Qwen3 30B A3B calibration and check the tokens per expert.
Summary by CodeRabbit
Release Notes